docs: enhance Support, Features, and Intro pages; improve image SEO, internal linking, clarity, and layout. #115
Conversation
WalkthroughThe pull request introduces significant updates across three documentation files: Changes
Poem
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
Deploying coderabbit-docs with
|
| Latest commit: |
e847df7
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://08cd88c1.coderabbit-docs.pages.dev |
| Branch Preview URL: | https://enhance-support-features-int.coderabbit-docs.pages.dev |
![coderabbitaidev[bot]](https://avatars.githubusercontent.com/in/375467?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 6
🧹 Outside diff range and nitpick comments (7)
docs/about/support.md (5)
11-13: Remove trailing space after section header.There's a trailing space after "Discord Server" on line 11.
-## Discord Server +## Discord Server🧰 Tools
🪛 Markdownlint
11-11: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
17-19: Add hyphen to compound modifier "bottom-right".For grammatical correctness, hyphenate the compound modifier.
-For assistance from our support team, click the help icon located in the bottom right corner of the [CodeRabbit UI] +For assistance from our support team, click the help icon located in the bottom-right corner of the [CodeRabbit UI]🧰 Tools
🪛 LanguageTool
[uncategorized] ~18-~18: Consider adding a hyphen.
Context: ...eam, click the help icon located in the bottom right corner of the [CodeRabbit UI](https://a...(TOP_LEFT_CORNER)
24-25: Enhance image accessibility with more descriptive alt text.The current image references could be more descriptive for screen readers.
- - + +
33-33: Remove trailing space after the introductory text.There's a trailing space at the end of the line.
-> To ensure efficient resolution of issues, customers are expected to +> To ensure efficient resolution of issues, customers are expected to:Also consider adding a colon to better introduce the list that follows.
🧰 Tools
🪛 Markdownlint
33-33: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
39-40: Fix formatting and grammar in Etiquette section.Several improvements needed:
- Add blank line before the heading
- Add missing comma in the list introduction
+ ## Etiquette -Regardless of the method or location through which CodeRabbit provides Support, communication should be professional and respectful. Any communication that is deemed objectionable by CodeRabbit staff is not tolerated. This includes but is not limited to any communication that is abusive or contains profane language. +Regardless of the method or location through which CodeRabbit provides Support, communication should be professional and respectful. Any communication that is deemed objectionable by CodeRabbit staff is not tolerated. This includes, but is not limited to, any communication that is abusive or contains profane language.🧰 Tools
🪛 LanguageTool
[uncategorized] ~40-~40: Possible missing comma found.
Context: ...it staff is not tolerated. This includes but is not limited to any communication tha...(AI_HYDRA_LEO_MISSING_COMMA)
🪛 Markdownlint
40-40: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
39-39: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
docs/about/pricing.md (2)
26-26: Use hyphenated compound adjective.When "Open Source" is used as a compound adjective modifying "projects", it should be hyphenated.
-CodeRabbit Pro is free for all Open Source projects. +CodeRabbit Pro is free for all Open-Source projects.🧰 Tools
🪛 LanguageTool
[uncategorized] ~26-~26: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ... :::note CodeRabbit Pro is free for all Open Source projects. ::: - Price: $0/month - ...(EN_COMPOUND_ADJECTIVE_INTERNAL)
102-103: Enhance image alt text for better accessibility and SEO.Consider making the alt text more descriptive to improve accessibility and SEO.
- + - + - + - +Also applies to: 109-110
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (4)
- docs/about/features.md (3 hunks)
- docs/about/pricing.md (4 hunks)
- docs/about/support.md (1 hunks)
- docs/guides/review-instructions.md (1 hunks)
🧰 Additional context used
🪛 Markdownlint
docs/about/features.md
27-27: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
88-88: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
docs/about/pricing.md
24-24: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
116-116: null
Files should end with a single newline character(MD047, single-trailing-newline)
docs/about/support.md
11-11: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
33-33: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
40-40: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
23-23: Expected: 1; Actual: 2
Multiple consecutive blank lines(MD012, no-multiple-blanks)
39-39: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
28-28: null
Bare URL used(MD034, no-bare-urls)
docs/guides/review-instructions.md
20-20: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
🪛 LanguageTool
docs/about/features.md
[uncategorized] ~78-~78: You might be missing the article “a” here.
Context: ... For quick fixes, CodeRabbit offers one button solution to commit AI recommende...(AI_EN_LECTOR_MISSING_DETERMINER_A)
docs/about/pricing.md
[uncategorized] ~26-~26: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ... :::note CodeRabbit Pro is free for all Open Source projects. ::: - Price: $0/month - ...(EN_COMPOUND_ADJECTIVE_INTERNAL)
docs/about/support.md
[uncategorized] ~18-~18: Consider adding a hyphen.
Context: ...eam, click the help icon located in the bottom right corner of the [CodeRabbit UI](https://a...(TOP_LEFT_CORNER)
[uncategorized] ~40-~40: Possible missing comma found.
Context: ...it staff is not tolerated. This includes but is not limited to any communication tha...(AI_HYDRA_LEO_MISSING_COMMA)
🔇 Additional comments (10)
docs/about/support.md (1)
7-9: LGTM: Clear and concise introduction.The welcome message effectively sets expectations for the support process.
docs/about/features.md (5)
2-3: LGTM! Improved title and navigation.The changes enhance branding while making the navigation more concise.
12-22: LGTM! Enhanced readability and brand consistency.The bold formatting and updated image captions improve the document's structure and brand visibility.
Line range hint
45-58: LGTM! Improved brand consistency.The bold formatting of "CodeRabbit" and updated image caption enhance brand visibility.
🧰 Tools
🪛 Markdownlint
27-27: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
62-65: LGTM! Enhanced image caption for SEO.The updated image caption improves searchability while maintaining clarity.
69-74: LGTM! Added helpful reference link.The addition of the Mermaid live editor link provides valuable context for users.
docs/about/pricing.md (3)
Line range hint
7-23: LGTM! Clear and well-structured introduction.The overview effectively communicates the key pricing aspects and value propositions.
48-57: LGTM! Clear pricing and usage limits.The pricing structure and usage limits are well-presented with appropriate emphasis on key numbers.
76-88: LGTM! Excellent plan comparison presentation.The table provides a clear, side-by-side comparison of features between Free and Pro plans.
docs/guides/review-instructions.md (1)
20-22: LGTM! Clear explanation of when custom instructions are needed.The added content effectively clarifies that custom instructions are only necessary for deviating from standard reviews. The blockquote example helps illustrate the point and improves the document's readability.
🧰 Tools
🪛 Markdownlint
20-20: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
| - **CodeRabbit** learns from user chat interactions to gain tribal knowledge on your | ||
| repositories and organization. | ||
| - **CodeRabbit** will apply and update these learnings | ||
| in future reviews. | ||
|
|
||
|  | ||
|  |
There was a problem hiding this comment.
Fix trailing whitespace.
There's a trailing whitespace on line 88 that should be removed.
Apply this diff:
-repositories and organization.
+repositories and organization.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - **CodeRabbit** learns from user chat interactions to gain tribal knowledge on your | |
| repositories and organization. | |
| - **CodeRabbit** will apply and update these learnings | |
| in future reviews. | |
|  | |
|  | |
| - **CodeRabbit** learns from user chat interactions to gain tribal knowledge on your | |
| repositories and organization. | |
| - **CodeRabbit** will apply and update these learnings | |
| in future reviews. | |
|  |
🧰 Tools
🪛 Markdownlint
88-88: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
| For quick fixes, **CodeRabbit** offers one button solution to commit AI recommended | ||
| changes. |
There was a problem hiding this comment.
Fix grammar in description.
Add the article "a" before "one button solution" for better grammar.
Apply this diff:
-For quick fixes, **CodeRabbit** offers one button solution to commit AI recommended
+For quick fixes, **CodeRabbit** offers a one-button solution to commit AI recommended📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| For quick fixes, **CodeRabbit** offers one button solution to commit AI recommended | |
| changes. | |
| For quick fixes, **CodeRabbit** offers a one-button solution to commit AI recommended | |
| changes. |
🧰 Tools
🪛 LanguageTool
[uncategorized] ~78-~78: You might be missing the article “a” here.
Context: ... For quick fixes, CodeRabbit offers one button solution to commit AI recommende...(AI_EN_LECTOR_MISSING_DETERMINER_A)
| **Code review** feedback is posted as review comments on the lines of the code that | ||
| changed for each file. | ||
|
|
||
| > Code suggestions are given in a Diff format, which either | ||
| be copied or committed within the pull request with a single click. | ||
|
|
||
|  | ||
|  | ||
|
|
||
| A review status is generated for each commit that is reviewed. It displays the | ||
| commit IDs that were reviewed, the files examined and ignored, as well as the | ||
| additional comments generated for each review, and so on. Review status is | ||
| useful for understanding the auxiliary context of the review. | ||
| additional comments generated for each review, and so on. | ||
|
|
||
|  | ||
| :::info | ||
| Review status is useful for understanding the auxiliary context of the review. | ||
| ::: | ||
|  |
There was a problem hiding this comment.
Fix trailing whitespace.
There's a trailing whitespace on line 27 that should be removed.
Apply this diff:
-changed for each file.
+changed for each file.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| **Code review** feedback is posted as review comments on the lines of the code that | |
| changed for each file. | |
| > Code suggestions are given in a Diff format, which either | |
| be copied or committed within the pull request with a single click. | |
|  | |
|  | |
| A review status is generated for each commit that is reviewed. It displays the | |
| commit IDs that were reviewed, the files examined and ignored, as well as the | |
| additional comments generated for each review, and so on. Review status is | |
| useful for understanding the auxiliary context of the review. | |
| additional comments generated for each review, and so on. | |
|  | |
| :::info | |
| Review status is useful for understanding the auxiliary context of the review. | |
| ::: | |
|  | |
| **Code review** feedback is posted as review comments on the lines of the code that | |
| changed for each file. | |
| > Code suggestions are given in a Diff format, which either | |
| be copied or committed within the pull request with a single click. | |
|  | |
| A review status is generated for each commit that is reviewed. It displays the | |
| commit IDs that were reviewed, the files examined and ignored, as well as the | |
| additional comments generated for each review, and so on. | |
| :::info | |
| Review status is useful for understanding the auxiliary context of the review. | |
| ::: | |
|  |
🧰 Tools
🪛 Markdownlint
27-27: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
docs/about/pricing.md
Outdated
| supported. Thus, pull requests or merge requests created by bots will not be | ||
| reviewed. | ||
| ::: |
There was a problem hiding this comment.
Add newline at end of file.
Add a newline character at the end of the file to comply with markdown best practices.
reviewed.
:::
+📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ::: | |
| ::: | |
🧰 Tools
🪛 Markdownlint
116-116: null
Files should end with a single newline character(MD047, single-trailing-newline)
| @@ -22,6 +21,18 @@ CodeRabbit. | |||
|
|
|||
| --- | |||
|
|
|||
| ## Open Source | |||
There was a problem hiding this comment.
Add blank line before heading.
Add a blank line before the "Open Source" heading to improve readability and comply with markdown best practices.
+
## Open Source📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ## Open Source | |
| ## Open Source |
🧰 Tools
🪛 Markdownlint
24-24: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
docs/guides/review-instructions.md
Outdated
| @@ -17,8 +17,9 @@ This section explains how to add custom code review instructions for the entire | |||
| project or specific file paths in your project using glob patterns. Developers | |||
| can provide tailored review guidelines based on the file paths. These | |||
| instructions are needed only if you want CodeRabbit to follow specific | |||
| instructions besides the standard review. For example, you may want to enforce a | |||
| style guide by file types or directories. | |||
| instructions besides the standard review. | |||
There was a problem hiding this comment.
Remove trailing space.
There is a trailing space at the end of line 20.
Apply this diff to fix the trailing space:
-instructions besides the standard review.
+instructions besides the standard review.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| instructions besides the standard review. | |
| instructions besides the standard review. |
🧰 Tools
🪛 Markdownlint
20-20: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
| - Number of files reviewed per hour: 150 Files | ||
| - Number of reviews per hour (includes incremental reviews): 9 | ||
| - Number of conversations per hour: 50 | ||
| - Number of files reviewed per hour: **150 Files** |
There was a problem hiding this comment.
@dikshant-infracloud can you take a look at this, considering the recent discussion
There was a problem hiding this comment.
hi @aravindputrevu , changes looks good. I have also updated the values to 150.
We should change the Number of reviews per hour (includes incremental reviews) to 8 to avoid any confusion.
There was a problem hiding this comment.
Thanks @dikshant-infracloud
There was a problem hiding this comment.
hi @aravindputrevu , changes looks good. I have also updated the values to 150.
We should change the Number of reviews per hour (includes incremental reviews) to 8 to avoid any confusion.
| - Number of files reviewed per hour: 150 Files | ||
| - Number of reviews per hour (includes incremental reviews): 9 | ||
| - Number of conversations per hour: 50 | ||
| - Number of files reviewed per hour: **150 Files** |
There was a problem hiding this comment.
hi @aravindputrevu , changes looks good. I have also updated the values to 150.
We should change the Number of reviews per hour (includes incremental reviews) to 8 to avoid any confusion.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (4)
docs/about/support.md (4)
17-21: Add hyphen for better readability.Consider adding a hyphen to "bottom-right" for improved readability.
-For assistance from our support team, click the help icon located in the bottom right corner of the [CodeRabbit UI] +For assistance from our support team, click the help icon located in the bottom-right corner of the [CodeRabbit UI]🧰 Tools
🪛 LanguageTool
[uncategorized] ~18-~18: Consider adding a hyphen.
Context: ...eam, click the help icon located in the bottom right corner of the [CodeRabbit UI](https://a...(TOP_LEFT_CORNER)
24-25: Enhance image accessibility with more descriptive alt text.The current alt text could be more descriptive to improve accessibility and SEO.
- - + +
31-37: LGTM! Well-structured customer responsibilities.The numbered list format effectively communicates expectations. Consider removing the trailing space after the introductory line for consistent formatting.
-To ensure efficient resolution of issues, customers are expected to +To ensure efficient resolution of issues, customers are expected to:🧰 Tools
🪛 Markdownlint
33-33: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
39-42: Address formatting and grammar in Etiquette section.The content is well-written, but there are minor formatting and grammar improvements needed.
- Add a blank line before the "Etiquette" heading
- Add a comma in the phrase "includes, but is not limited to"
+ ## Etiquette -Regardless of the method or location through which CodeRabbit provides Support, communication should be professional and respectful. Any communication that is deemed objectionable by CodeRabbit staff is not tolerated. This includes but is not limited to any communication that is abusive or contains profane language. +Regardless of the method or location through which CodeRabbit provides Support, communication should be professional and respectful. Any communication that is deemed objectionable by CodeRabbit staff is not tolerated. This includes, but is not limited to, any communication that is abusive or contains profane language.🧰 Tools
🪛 LanguageTool
[uncategorized] ~40-~40: Possible missing comma found.
Context: ...it staff is not tolerated. This includes but is not limited to any communication tha...(AI_HYDRA_LEO_MISSING_COMMA)
🪛 Markdownlint
40-40: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
39-39: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
- docs/about/support.md (1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/about/support.md
[uncategorized] ~18-~18: Consider adding a hyphen.
Context: ...eam, click the help icon located in the bottom right corner of the [CodeRabbit UI](https://a...(TOP_LEFT_CORNER)
[uncategorized] ~40-~40: Possible missing comma found.
Context: ...it staff is not tolerated. This includes but is not limited to any communication tha...(AI_HYDRA_LEO_MISSING_COMMA)
🪛 Markdownlint
docs/about/support.md
11-11: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
33-33: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
40-40: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
23-23: Expected: 1; Actual: 2
Multiple consecutive blank lines(MD012, no-multiple-blanks)
39-39: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
28-28: null
Bare URL used(MD034, no-bare-urls)
🔇 Additional comments (1)
docs/about/support.md (1)
7-13: LGTM! Clear and concise introduction with accurate Discord information.The simplified introduction and Discord server section effectively communicate the essential information.
🧰 Tools
🪛 Markdownlint
11-11: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
…internal linking, clarity, and layout
…internal linking, clarity, and layout
tyaga001
force-pushed
the
enhance/support-features-intro-pages
branch
from
0287087 to
1dd5ff7
Compare
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Outside diff range and nitpick comments (7)
docs/about/support.md (6)
7-9: Consider removing the response time promise.The statement "Our support team will respond back as soon as possible" could set unrealistic expectations. Consider removing this or providing specific response time targets based on your service level agreements.
Welcome to CodeRabbit Support. Please refer to the following sections for -contacting our support team. Our support team will respond back as soon as -possible. +contacting our support team.
11-13: Fix trailing whitespace.Remove the trailing space after "Discord Server" on line 11 to comply with markdown formatting guidelines.
🧰 Tools
🪛 Markdownlint
11-11: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
24-25: Enhance image accessibility with alt text.The images should have more descriptive alt text for better accessibility.
- - + +
18-18: Add hyphen to "bottom-right".For consistency and clarity, add a hyphen to "bottom-right" in the UI location description.
-For assistance from our support team, click the help icon located in the bottom right corner of the [CodeRabbit UI] +For assistance from our support team, click the help icon located in the bottom-right corner of the [CodeRabbit UI]🧰 Tools
🪛 LanguageTool
[uncategorized] ~18-~18: Consider adding a hyphen.
Context: ...eam, click the help icon located in the bottom right corner of the [CodeRabbit UI](https://a...(TOP_LEFT_CORNER)
33-33: Remove trailing whitespace.Remove the trailing space at the end of line 33.
🧰 Tools
🪛 Markdownlint
33-33: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
39-42: Add blank line before heading and improve policy clarity.
- Add a blank line before the "Etiquette" heading for proper markdown formatting.
- Consider making the termination policy more specific.
+ ## Etiquette Regardless of the method or location through which CodeRabbit provides Support, communication should be professional and respectful. Any communication that is deemed objectionable by CodeRabbit staff is not tolerated. This includes but is not limited to any communication that is abusive or contains profane language. -> CodeRabbit reserves the right to terminate Support Services in the event of any such objectionable communication. +> CodeRabbit reserves the right to terminate Support Services immediately and without prior notice in the event of any such objectionable communication.🧰 Tools
🪛 Markdownlint
40-40: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
39-39: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
docs/about/features.md (1)
70-70: Improve Mermaid link description.The current link text could be more descriptive about its purpose.
Apply this diff:
-[Mermaid Sequence Diagram Example](https://mermaid.live/). +[Mermaid Live Editor for Sequence Diagrams](https://mermaid.live/).
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (3)
- docs/about/features.md (3 hunks)
- docs/about/pricing.md (4 hunks)
- docs/about/support.md (1 hunks)
🧰 Additional context used
🪛 Markdownlint
docs/about/features.md
27-27: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
88-88: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
docs/about/pricing.md
24-24: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
116-116: null
Files should end with a single newline character(MD047, single-trailing-newline)
docs/about/support.md
11-11: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
33-33: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
40-40: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
23-23: Expected: 1; Actual: 2
Multiple consecutive blank lines(MD012, no-multiple-blanks)
39-39: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
28-28: null
Bare URL used(MD034, no-bare-urls)
🪛 LanguageTool
docs/about/pricing.md
[uncategorized] ~26-~26: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ... :::note CodeRabbit Pro is free for all Open Source projects. ::: - Price: $0/month - ...(EN_COMPOUND_ADJECTIVE_INTERNAL)
docs/about/support.md
[uncategorized] ~18-~18: Consider adding a hyphen.
Context: ...eam, click the help icon located in the bottom right corner of the [CodeRabbit UI](https://a...(TOP_LEFT_CORNER)
🔇 Additional comments (6)
docs/about/features.md (4)
2-3: LGTM! Title and sidebar changes improve clarity.The simplified navigation labels while maintaining brand presence is a good improvement.
27-27: Fix trailing whitespace.This issue was previously identified and still needs to be addressed.
🧰 Tools
🪛 Markdownlint
27-27: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
78-79: Fix grammar in description.This grammar issue was previously identified and still needs to be addressed.
88-88: Fix trailing whitespace.This issue was previously identified and still needs to be addressed.
🧰 Tools
🪛 Markdownlint
88-88: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
docs/about/pricing.md (2)
76-88: Great addition of the comparison table!The table provides a clear, at-a-glance comparison of the plans, making it easier for users to make informed decisions.
112-116:⚠️ Potential issueAdd newline at end of file.
Add a newline character at the end of the file to comply with markdown best practices.
Apply this diff:
reviewed. ::: +🧰 Tools
🪛 Markdownlint
116-116: null
Files should end with a single newline character(MD047, single-trailing-newline)
| CodeRabbit visualizes the changes occuring in any pull request using | ||
| [Mermaid Diagrams](https://mermaid.live/). | ||
| **CodeRabbit** visualizes the changes occuring in any pull request using | ||
| [Mermaid Sequence Diagram Example](https://mermaid.live/). | ||
|
|
||
|  |
There was a problem hiding this comment.
Update image caption to match branding pattern.
For consistency with other image captions, this should follow the CodeRabbit branding pattern.
Apply this diff:
-
+📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
|  | |
|  |
There was a problem hiding this comment.
@coderabbitai remember to make all markdown image tags to follow SEO guidelines. Like the one listed here. Make this consistent across Docs Pull Requests.
There was a problem hiding this comment.
@aravindputrevu, understood. I'll ensure all markdown image tags in the documentation follow SEO guidelines and maintain consistency across Docs Pull Requests.
(_/)
(•_•)
/>🌱
✏️ Learnings added
Learnt from: aravindputrevu
PR: coderabbitai/coderabbit-docs#115
File: docs/about/features.md:72-72
Timestamp: 2024-10-24T10:08:27.685Z
Learning: In documentation files, ensure all markdown image tags follow SEO guidelines and maintain consistency across Docs Pull Requests.
Note: Learnings are effective only in the context of similar code segments. To apply general coding guidelines, please configure review instructions. You can manage existing learnings in the app.
| > Code suggestions are given in a Diff format, which either | ||
| be copied or committed within the pull request with a single click. |
There was a problem hiding this comment.
Improve blockquote clarity and grammar.
The current blockquote about code suggestions could be clearer.
Apply this diff:
-> Code suggestions are given in a Diff format, which either
-be copied or committed within the pull request with a single click.
+> Code suggestions are provided in a Diff format, which can be either
+> copied or committed within the pull request with a single click.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| > Code suggestions are given in a Diff format, which either | |
| be copied or committed within the pull request with a single click. | |
| > Code suggestions are provided in a Diff format, which can be either | |
| > copied or committed within the pull request with a single click. |
| ## Open Source | ||
| :::note | ||
| CodeRabbit Pro is free for all Open Source projects. | ||
| ::: |
There was a problem hiding this comment.
Fix markdown formatting and hyphenation.
Two minor improvements needed:
- Add a blank line before the "Open Source" heading
- Hyphenate "Open-Source" when used as a compound adjective
Apply this diff:
+
## Open Source
:::note
-CodeRabbit Pro is free for all Open Source projects.
+CodeRabbit Pro is free for all Open-Source projects.
:::📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ## Open Source | |
| :::note | |
| CodeRabbit Pro is free for all Open Source projects. | |
| ::: | |
| ## Open Source | |
| :::note | |
| CodeRabbit Pro is free for all Open-Source projects. | |
| ::: |
🧰 Tools
🪛 LanguageTool
[uncategorized] ~26-~26: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ... :::note CodeRabbit Pro is free for all Open Source projects. ::: - Price: $0/month - ...(EN_COMPOUND_ADJECTIVE_INTERNAL)
🪛 Markdownlint
24-24: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Outside diff range and nitpick comments (1)
docs/about/pricing.md (1)
76-88: Consider enhancing table clarity and consistency.The comparison table is informative but could be improved:
- Replace vague "Limited" descriptions with specific limits where possible
- Consider consistent formatting for similar items (e.g., "Included" vs "Yes")
Example improvements:
-| **Private Repos** | Limited access | Unlimited access| +| **Private Repos** | PR summary only | Unlimited access| -| **Hourly Usage Limits** | Limited | 150 files/hour, 9 reviews/hour, 50 conversations/hour | +| **Hourly Usage Limits** | 50 files/hour, 3 reviews/hour, 10 conversations/hour | 150 files/hour, 9 reviews/hour, 50 conversations/hour |
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
- docs/about/pricing.md (4 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/about/pricing.md
[uncategorized] ~26-~26: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ... :::note CodeRabbit Pro is free for all Open Source projects. ::: - Price: $0/month - ...(EN_COMPOUND_ADJECTIVE_INTERNAL)
🪛 Markdownlint
docs/about/pricing.md
24-24: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
🔇 Additional comments (4)
docs/about/pricing.md (4)
Line range hint
7-22: LGTM! Clear and well-structured overview section.The overview effectively communicates key pricing information with well-organized bullet points.
24-33: LGTM! Clear open-source policy.The section effectively communicates the free offering for open-source projects.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~26-~26: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ... :::note CodeRabbit Pro is free for all Open Source projects. ::: - Price: $0/month - ...(EN_COMPOUND_ADJECTIVE_INTERNAL)
🪛 Markdownlint
24-24: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
Line range hint
59-74: LGTM! Clear free plan description.The section effectively communicates the features and limitations of the free plan.
90-116: LGTM! Well-structured subscription management section.The section effectively communicates subscription management details with proper image handling for dark/light modes.
| - Number of files reviewed per hour: **150 Files** | ||
| - Number of reviews per hour (includes incremental reviews): **8** | ||
| - Number of conversations per hour: **50** |
There was a problem hiding this comment.
Fix inconsistent review limit values.
There's a discrepancy in the stated number of reviews per hour:
- Usage Limits section states "8" reviews per hour
- Plan Comparison table states "9" reviews per hour
Please update one of these values to ensure consistency.
Also applies to: 86-86
No description provided.